Access APIs

Access APIs for managing users, roles, tenants and other related system security operations

Function

Description

Version

Examples

Ent. Admin

Dom. Admin

Pro User

Analyst User

Viewer User

Basic User

addAnalystProfile

Add an Analyst User Profile

2023.10

addDomainSettings

Add new AD LDAP server

2023.10

addProProfile

Add a Professional User Profile

2023.10

addScientistProfile

Add a Scientist User Profile

2023.10

addUserToRole

Add a user to a Role

2023.10

addUsersToRole

Add Users to a Role

2023.10

addViewerProfile

Add a Viewer User Profile

2023.10

changeUserLicense

Change a User’s License Type

2023.10

createRole

Create a Security Role

2023.10

createRoles

Create Security Roles

2023.10

createTenant

Create a Tenant

2023.10

createTenants

Create Multiple Tenants

2023.10

createUsers

Create multiple users

2023.14

createUsersFromSearch

Create multiple users from search

2023.14

deleteProfile

Removes a user profile from the system

2023.10

deleteRole

Delete a Role

2023.10

deleteTenants

Delete Tenants

2023.10

deleteUser

Delete a User

2023.10

findRoles

Find Security Roles

2023.10

getAllAnalystProfiles

Gets a listing all Analyst profiles

2023.12

getAllProfessionalProfiles

Gets a listing all Professional profiles

2023.12

getAllRoles

Get All Roles

2023.10

getAllScientistProfiles

Gets a listing all Scientist profiles

2023.12

getAllTenants

Get all Tenants

2023.10

getAllViewerProfiles

Gets a listing all Viewer profiles

2023.12

getDefaultTenant

Get the default tenant ID

2023.10

getLicenseCount

Get Tenant License Count

2023.10

getLicenseExpirationDate

Get License Expiration Date

2023.10

getLicenseValidationStatus

Get License Status

2023.10

getMe

Gets details for the current user.

2023.14

getProfileForUser

Returns the profile assigned to the specified user

2023.10

getPublicRoles

Get All Public Roles

2023.10

getPublicRolesByTenant

Get All Public Roles for a Tenant

2023.10

getRoleById

Get a Security Role by ID

2023.10

getRoleGroups

Get external groups for a role

2023.14

getRolesByUser

Get all Roles for a User

2023.10

getRolesbyProfile

Returns a list of roles assigned to the specified user profile

2023.10

getTenantByName

Get Tenant by Name

2023.10

getTenantUnusedLicenseCount

Get Available License Count for a Tenant

2023.10

getTenantUsersByUserType

Get a Tenant's Users with specific license type

2023.14

getUser

Get a User via ID

2023.14

getUserByPrincipalName

Get a User by UPN

2023.14

getUserLastLogin

Get User Last Login Timestamp

2023.10

getUserStatusById

Get User's System Status by User ID

2023.10

getUserStatusByName

Get User's System Status by Name

2023.10

getUsersByCurrentTenant

Get the Current Tenant's Users

2023.10

getUsersByName

Get a User by UserName

2023.14

getUsersByRole

Get all Users in a Role

2023.14

getUsersByTenant

Get a Tenant's Users

2023.10

searchExternalGroups

Search external groups

2023.14

searchExternalUsers

Search for External users

2023.14

searchGroupUsers

Search external group members

2023.14

searchUserGroups

Search User’s external groups

2023.14

setUserAdministrationLevel

Set User's Administration Level

2023.10

toggleUserStatus

Change User's Status

2023.10

updateDomainAdminPermissions

Update Domain Admin Permissions

2023.10

updateRoleGroups

Update external groups in a role

2023.14

updateRoleProfiles

Update Role Profiles

2023.10

updateTenant

Update a Tenant

2023.10

updateTenantSeats

Updates a tenant seats

2023.10

updateUserRoles

Update a User’s Roles

2023.10

updateUsers

Update users

2023.14

updateUsersFromSearch

Update user settings

2023.14

updateUsersPhones

Update phones of users

2023.10